<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>XenC: SimplePPL Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">XenC
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Open-source tool for data selection in NLP</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_simple_p_p_l-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SimplePPL Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Filtering mode 1: simple perplexity.  
 <a href="class_simple_p_p_l.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="simple_p_p_l_8h_source.html">simplePPL.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SimplePPL:</div>
<div class="dyncontent">
<div class="center"><img src="class_simple_p_p_l__inherit__graph.png" border="0" usemap="#_simple_p_p_l_inherit__map" alt="Inheritance graph"/></div>
<map name="_simple_p_p_l_inherit__map" id="_simple_p_p_l_inherit__map">
<area shape="rect" id="node2" href="class_mode.html" title="Filtering modes interface. " alt="" coords="22,5,76,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for SimplePPL:</div>
<div class="dyncontent">
<div class="center"><img src="class_simple_p_p_l__coll__graph.png" border="0" usemap="#_simple_p_p_l_coll__map" alt="Collaboration graph"/></div>
<map name="_simple_p_p_l_coll__map" id="_simple_p_p_l_coll__map">
<area shape="rect" id="node2" href="class_mode.html" title="Filtering modes interface. " alt="" coords="22,5,76,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4847d9022bc36cde2b9bef502673aff3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_p_p_l.html#a4847d9022bc36cde2b9bef502673aff3">SimplePPL</a> ()</td></tr>
<tr class="memdesc:a4847d9022bc36cde2b9bef502673aff3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a4847d9022bc36cde2b9bef502673aff3">More...</a><br /></td></tr>
<tr class="separator:a4847d9022bc36cde2b9bef502673aff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada52ca31f9a81e3a04ff3c9d28fa1421"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_p_p_l.html#ada52ca31f9a81e3a04ff3c9d28fa1421">~SimplePPL</a> ()</td></tr>
<tr class="memdesc:ada52ca31f9a81e3a04ff3c9d28fa1421"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#ada52ca31f9a81e3a04ff3c9d28fa1421">More...</a><br /></td></tr>
<tr class="separator:ada52ca31f9a81e3a04ff3c9d28fa1421"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cbcec72a693b6bf700c3d1802026be1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_p_p_l.html#a0cbcec72a693b6bf700c3d1802026be1">launch</a> ()</td></tr>
<tr class="memdesc:a0cbcec72a693b6bf700c3d1802026be1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function in charge of launching the filtering mode.  <a href="#a0cbcec72a693b6bf700c3d1802026be1">More...</a><br /></td></tr>
<tr class="separator:a0cbcec72a693b6bf700c3d1802026be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_mode"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_mode')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_mode.html">Mode</a></td></tr>
<tr class="memitem:a8876d05ec6622862d06880fa55c590ab inherit pub_methods_class_mode"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mode.html#a8876d05ec6622862d06880fa55c590ab">~Mode</a> ()=0</td></tr>
<tr class="memdesc:a8876d05ec6622862d06880fa55c590ab inherit pub_methods_class_mode"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pure virtual destructor.  <a href="#a8876d05ec6622862d06880fa55c590ab">More...</a><br /></td></tr>
<tr class="separator:a8876d05ec6622862d06880fa55c590ab inherit pub_methods_class_mode"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_static_methods_class_mode"><td colspan="2" onclick="javascript:toggleInherit('pro_static_methods_class_mode')"><img src="closed.png" alt="-"/>&#160;Static Protected Member Functions inherited from <a class="el" href="class_mode.html">Mode</a></td></tr>
<tr class="memitem:a4f9db1a2844c3f9be520c2882446443a inherit pro_static_methods_class_mode"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mode.html#a4f9db1a2844c3f9be520c2882446443a">findSampleSize</a> (boost::shared_ptr&lt; <a class="el" href="class_corpus.html">Corpus</a> &gt; idCorp, boost::shared_ptr&lt; <a class="el" href="class_corpus.html">Corpus</a> &gt; oodCorp)</td></tr>
<tr class="memdesc:a4f9db1a2844c3f9be520c2882446443a inherit pro_static_methods_class_mode"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the optimal sample size for the OOD <a class="el" href="class_corpus.html" title="Corpus-related functionalities. ">Corpus</a>.  <a href="#a4f9db1a2844c3f9be520c2882446443a">More...</a><br /></td></tr>
<tr class="separator:a4f9db1a2844c3f9be520c2882446443a inherit pro_static_methods_class_mode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08d61f2bf10a36780a805fd64f43886d inherit pro_static_methods_class_mode"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_corpus.html">Corpus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_mode.html#a08d61f2bf10a36780a805fd64f43886d">extractSample</a> (boost::shared_ptr&lt; <a class="el" href="class_corpus.html">Corpus</a> &gt; ptrCorp, int sSize, bool mean)</td></tr>
<tr class="memdesc:a08d61f2bf10a36780a805fd64f43886d inherit pro_static_methods_class_mode"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts a random sample from a give <a class="el" href="class_corpus.html" title="Corpus-related functionalities. ">Corpus</a>.  <a href="#a08d61f2bf10a36780a805fd64f43886d">More...</a><br /></td></tr>
<tr class="separator:a08d61f2bf10a36780a805fd64f43886d inherit pro_static_methods_class_mode"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Filtering mode 1: simple perplexity. </p>
<p>This class derived from <a class="el" href="class_mode.html" title="Filtering modes interface. ">Mode</a> handles the first filtering mode: simple perplexity </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4847d9022bc36cde2b9bef502673aff3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SimplePPL::SimplePPL </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default constructor. </p>

</div>
</div>
<a class="anchor" id="ada52ca31f9a81e3a04ff3c9d28fa1421"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SimplePPL::~SimplePPL </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0cbcec72a693b6bf700c3d1802026be1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int SimplePPL::launch </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Function in charge of launching the filtering mode. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if the filtering succeeds </dd></dl>

<p>Implements <a class="el" href="class_mode.html#af43f7539ee52f4ffa38e532fa1144ef2">Mode</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_simple_p_p_l_a0cbcec72a693b6bf700c3d1802026be1_cgraph.png" border="0" usemap="#class_simple_p_p_l_a0cbcec72a693b6bf700c3d1802026be1_cgraph" alt=""/></div>
<map name="class_simple_p_p_l_a0cbcec72a693b6bf700c3d1802026be1_cgraph" id="class_simple_p_p_l_a0cbcec72a693b6bf700c3d1802026be1_cgraph">
<area shape="rect" id="node2" href="class_xen_option.html#a97ad096aee729b4d8ae993b1381d4eec" title="Accessor to the instance of the singleton XenOption object. " alt="" coords="425,63,586,88"/>
<area shape="rect" id="node3" href="class_static_data.html#a3cc0816b2220ee3f827cdd00971e010d" title="Accessor to the instance of the singleton StaticData object. " alt="" coords="201,211,360,236"/>
<area shape="rect" id="node4" href="class_static_data.html#a60a4636843c37cbb31780ec4d185a06d" title="Accessor to the source language Corpus Pair. " alt="" coords="187,260,374,285"/>
<area shape="rect" id="node5" href="class_xen_option.html#a17723ab17afa712bfc7a9539719abf94" title="Accessor to the source language in&#45;domain data file. " alt="" coords="201,309,360,335"/>
<area shape="rect" id="node6" href="class_xen_option.html#a9886771703c5b8866be587f50193ac9d" title="Accessor to the source language. " alt="" coords="206,359,355,384"/>
<area shape="rect" id="node7" href="class_xen_option.html#a8c54e1795dc493d23fa38d977c09604d" title="Accessor to the source language out&#45;of&#45;domain data file. " alt="" coords="196,408,365,433"/>
<area shape="rect" id="node8" href="class_xen_option.html#a74178ef5302c1bf213822ae474c58806" title="Accessor to the source language vocabulary file. " alt="" coords="202,457,359,483"/>
<area shape="rect" id="node9" href="class_xen_option.html#a02ab4cb865a93cf7c48f76f68f7b6ae9" title="Accessor to the global vocabulary execution state. " alt="" coords="196,507,365,532"/>
<area shape="rect" id="node10" href="class_static_data.html#a0a84fa1648aed88951cf2870a9f39b4d" title="Accessor to the vocabularies. " alt="" coords="204,556,357,581"/>
<area shape="rect" id="node11" href="class_xen_option.html#a1eb0d4f4b3d29749f6ac70e71c9fa01b" title="Accessor to the source language in&#45;domain language model file. " alt="" coords="206,605,355,631"/>
<area shape="rect" id="node12" href="class_static_data.html#a3104f8fe8394b6456f12f8ddca6a3f07" title="Accessor to the source language models. " alt="" coords="193,655,369,680"/>
<area shape="rect" id="node13" href="class_static_data.html#a292e282fda19f6ee5d7fc770c66f4ddc" title="Accessor to the source language PPL objects. " alt="" coords="189,704,372,729"/>
<area shape="rect" id="node14" href="class_xen_option.html#a9eb5309135ec46b588dcc98c196303ea" title="Accessor to the weights file. " alt="" coords="208,753,353,779"/>
<area shape="rect" id="node15" href="class_static_data.html#a629e38d09dd808708b0be118b7f9a6d0" title="Accessor to the weights file. " alt="" coords="192,803,370,828"/>
<area shape="rect" id="node16" href="class_static_data.html#a0209ea694e46c5eb62e68a17b7eca7d1" title="Accessor to the ScoreHolder object. " alt="" coords="205,852,357,877"/>
<area shape="rect" id="node17" href="class_xen_option.html#ad4b6a223068d8c75797e716887b5b9cc" title="Accessor to the inverted filtered output state. " alt="" coords="217,901,345,927"/>
<area shape="rect" id="node18" href="class_xen_option.html#aaaec9eadf81b57f24f4833be2ff2350a" title="Accessor to the target language. " alt="" coords="207,951,355,976"/>
<area shape="rect" id="node19" href="namespace_xen_common.html#ad4f4868634e46d6ee82e57d343a77abe" title="Template converting a value into a string with a precision of 20. " alt="" coords="429,13,582,39"/>
<area shape="rect" id="node20" href="class_xen_i_o.html#ab9a2f3c55823d6f5bf73e291fb51030d" title="Monolingual corpus cleaning (ensures no empty lines) " alt="" coords="193,1000,368,1025"/>
<area shape="rect" id="node21" href="class_xen_i_o.html#ac4fbd0582c974bb4c11c225ef467f26a" title="Writes monolingual scored/sorted result files. " alt="" coords="197,161,365,187"/>
<area shape="rect" id="node25" href="class_xen_option.html#a45a1ac5576924aec7f0fea15e28d0f40" title="Accessor to the target language out&#45;of&#45;domain data file. " alt="" coords="197,1049,365,1075"/>
<area shape="rect" id="node26" href="class_xen_i_o.html#a19e9b18d89fa44de07082e50899e9c42" title="Bilingual corpus cleaning (ensures no empty lines) " alt="" coords="204,1099,357,1124"/>
<area shape="rect" id="node27" href="class_xen_i_o.html#ad3264b7bde95ba72494ab9db3804ad11" title="Writes bilingual scored/sorted result files. " alt="" coords="207,112,354,137"/>
<area shape="rect" id="node22" href="class_xen_option.html#a6b020f1c16f0e0699a5ea7e06a0f593d" title="Accessor to the output name for the filtered files. " alt="" coords="422,112,589,137"/>
<area shape="rect" id="node23" href="class_xen_option.html#acf6b028eb04afc2c9a6fe9a16ea6af3a" title="Accessor to whether we output the scored file. " alt="" coords="425,161,587,187"/>
<area shape="rect" id="node24" href="class_xen_option.html#a1b9f650f28eee13014332ac9ac6dd0ec" title="Accessor to the reversed filtered output state. " alt="" coords="439,211,573,236"/>
</map>
</div>
</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/modes/<a class="el" href="simple_p_p_l_8h_source.html">simplePPL.h</a></li>
<li>src/modes/<a class="el" href="simple_p_p_l_8cpp.html">simplePPL.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 18 2016 17:22:37 for XenC by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
